版本：V3.0

用户管理API

获取用户列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
account_id	String	Body	账号ID
account_name	String	Body	账号名称
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	邮箱
phone	String	Body	电话
auth	String	Body	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户
region	String	Body	区域
payment_status	String	Body	付费状态 inactivated：未激活 normal：正常 expired：已过期

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": [
    {
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "account_id": "a1a621c1ae77040d697bd2134700f57ee",
      "account_name": "test@akubela.com",
      "first_name": "Fly",
      "last_name": "Dom",
      "phone": "1234567",
      "email": "test@akubela.com",
      "auth": "admin",
      "region": "Island",
      "payment_status": "normal"
    }
  ]
}

失败返回示例

见接口失败返回

获取用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
account_name	String	Body	账号名称
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	邮箱
phone	String	Body	电话
auth	String	Body	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户
region	String	Body	区域
payment_status	String	Body	付费状态 inactivated：未激活 normal：正常 expired：已过期

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "account_name": "test@akubela.com",
    "first_name": "Fly",
    "last_name": "Dom",
    "phone": "1234567",
    "email": "test@akubela.com",
    "auth": "admin",
    "region": "Island",
    "payment_status": "normal"
  }
}

失败返回示例

见接口失败返回

创建用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
building_id	String	Body	是	楼栋ID
first_name	String	Body	是	名
last_name	String	Body	是	姓
email	String	Body	是	邮箱
auth	String	Body	是	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
account_id	String	Body	账号ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "building_id": "br2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "first_name": "Fly",
    "last_name": "Dom",
    "email": "test@akubela.com",
    "auth": "admin"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "account_id": "a1a621c1ae77040d697bd2134700f57ea"
  }
}

失败返回示例

见接口失败返回

批量创建用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	[]Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
building_id	String	Body	是	楼栋ID
first_name	String	Body	是	名
last_name	String	Body	是	姓
email	String	Body	是	邮箱
auth	String	Body	是	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_create_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "building_id": "br2c4b070cc928496198944858b344fc6",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
      "first_name": "Fly",
      "last_name": "Dom",
      "email": "test@akubela.com",
      "auth": "admin"
    }
  ]
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

更新用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
first_name	String	Body	是	名
last_name	String	Body	是	姓

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "first_name": "Fly",
    "last_name": "Dom"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

更新用户密码

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
new_password	String	Body	是	新密码

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_password",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "new_password": "new_1234567As"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

删除用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
account_id	String	Body	是	账号ID
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "residence_id": "re1adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "a1b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

批量删除用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
accounts	[]Object<account>	Body	是	账号信息

account说明

参数名	类型	位置	必填	说明
account_id	String	Body	是	账号ID
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "residence_id": "re1adc223cc4b3bedb6bd4742dedcfa52",
        "account_id": "a1b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

导入用户信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
file_name	String	Body	是	文件名称
file_url	String	Body	是	文件地址

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
task_id	String	Body	任务ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-user"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

失败返回示例

见接口失败返回

获取用户权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
faces	[]Object<face>	Body	人脸信息
pin_codes	[]Object<pin_code>	Body	PIN码信息
rf_cards	[]Object<rf_card>	Body	射频卡信息
access_groups	[]Object<access_group>	Body	权限组信息
floor_access	[]String	Body	楼层权限

face说明

参数名	类型	位置	说明
face_id	String	Body	人脸ID
created_time	String	Body	创建时间，UTC
creator	String	Body	创建人

pin_code说明

参数名	类型	位置	说明
pin_code_id	String	Body	PIN码ID
number	String	Body	号码
created_time	String	Body	创建时间，UTC
creator	String	Body	创建人

rf_card说明

参数名	类型	位置	说明
rf_card_id	String	Body	射频卡ID
number	String	Body	号码
created_time	String	Body	创建时间，UTC
creator	String	Body	创建人

access_group说明

参数名	类型	位置	说明
access_group_id	String	Body	权限组ID
access_group_name	String	Body	权限组名称
access_group_type	String	Body	权限组类型 system：系统 customized：定制

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "floor_access": [
      "1",
      "2"
    ],
    "faces": [
      {
        "face_id": "fbr2c4b070cc928496198944858b344fc",
        "created_time": "2024-07-17 09:00:46",
        "creator": "pm"
      }
    ],
    "pin_codes": [
      {
        "pin_code_id": "pbr2c4b070cc928496198944858b344fc",
        "number": "123456",
        "created_time": "2024-07-17 19:00:46",
        "creator": "pm"
      }
    ],
    "rf_cards": [
      {
        "rf_card_id": "rbr2c4b070cc928496198944858b344fc",
        "number": "123456",
        "created_time": "2024-07-17 14:00:46",
        "creator": "pm"
      }
    ],
    "access_groups": [
      {
        "access_group_name": "test",
        "access_group_id": "arbr2c4b070cc928496198944858b344f",
        "access_group_type": "system"
      }
    ]
  }
}

失败返回示例

见接口失败返回

更新用户楼层权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
floor_access	[]String	Body	否	楼层权限

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_floor_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "floor_access": [
      "all"
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

创建用户PIN码权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
number	String	Body	是	号码

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
pin_code_id	String	Body	PIN码ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_pin_code_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "number": "1234567"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "pin_code_id": "p1a621c1ae77040d697bd2134700f57ea"
  }
}

失败返回示例

见接口失败返回

删除用户PIN码权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
pin_code_id	String	Body	是	PIN码ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_pin_code_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "pin_code_id": "pdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

创建用户射频卡权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
number	String	Body	是	号码

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
rf_card_id	String	Body	射频卡ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "number": "1234567"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "rf_card_id": "r1a621c1ae77040d697bd2134700f57ea"
  }
}

失败返回示例

见接口失败返回

删除用户射频卡权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
rf_card_id	String	Body	是	射频卡ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "rf_card_id": "rdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

创建用户人脸权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
face_picture_url	String	Body	是	人脸图片地址

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "face_picture_url": "https://akcs.akubela.com/test"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

删除用户人脸权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	账号ID
face_id	String	Body	是	人脸ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "face_id": "fdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

导入用户PIN码与射频卡权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
file_name	String	Body	是	文件名称
file_url	String	Body	是	文件地址

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
task_id	String	Body	任务ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_pin_code_and_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-pin-card"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

失败返回示例

见接口失败返回

导入用户人脸权限信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
file_name	String	Body	是	文件名称
file_url	String	Body	是	文件地址

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
task_id	String	Body	任务ID

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-face"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

失败返回示例

见接口失败返回

获取用户列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取用户信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

创建用户信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

批量创建用户信息​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

更新用户信息​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

更新用户密码​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

删除用户信息​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

批量删除用户信息​

接口地址​

请求参数​

param说明​

account说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

导入用户信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取用户权限信息​

接口地址​

请求参数​

获取用户列表

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取用户信息

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

创建用户信息

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

批量创建用户信息

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

更新用户信息

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

更新用户密码

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

删除用户信息

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

批量删除用户信息

接口地址

请求参数

param说明

account说明

返回参数

请求示例

成功返回示例

失败返回示例

导入用户信息

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取用户权限信息

接口地址

请求参数